home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il_c / ilSepKernel.z / ilSepKernel
Encoding:
Text File  |  2002-10-03  |  9.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll - a separable kernel
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilKernel
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilCdefs.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilSepKernel implements a separable kernel. A kernel is defined by a data
  19.      type, the sizes of the _x, _y, and _z vectors, and the data for the vectors.
  20.      ilSepKernel also provides functions to access kernel data.
  21.  
  22. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  23.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  24.  
  25.           ilSepKernelIlSepKernel(ilSepKernel *obj, iflDataType type,
  26.                                  void *xdata, int x, void *ydata,
  27.                                  int y, void *zdata, int z)
  28.  
  29.  
  30.      FFFFuuuunnnnccccttttiiiioooonnnnssss ttttoooo sssseeeetttt////ggggeeeetttt kkkkeeeerrrrnnnneeeellll ddddaaaattttaaaa
  31.  
  32.           void *ilSepKernelGetXdata(ilSepKernel *obj)
  33.           void *ilSepKernelGetYdata(ilSepKernel *obj)
  34.           void *ilSepKernelGetZdata(ilSepKernel *obj)
  35.           void ilSepKernelSetXdata(ilSepKernel *obj, void *xKernel)
  36.           void ilSepKernelSetYdata(ilSepKernel *obj, void *yKernel)
  37.           void ilSepKernelSetZdata(ilSepKernel *obj, void *zKernel)
  38.           double ilSepKernelGetXelement(ilSepKernel *obj, int n)
  39.           double ilSepKernelGetYelement(ilSepKernel *obj, int n)
  40.           double ilSepKernelGetZelement(ilSepKernel *obj, int n)
  41.           void ilSepKernelSetXelement(ilSepKernel *obj, double val,
  42.                                       int n)
  43.           void ilSepKernelSetYelement(ilSepKernel *obj, double val,
  44.                                       int n)
  45.           void ilSepKernelSetZelement(ilSepKernel *obj, double val,
  46.                                       int n)
  47.  
  48.  
  49. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  50.      iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll(((())))
  51.  
  52.      ilSepKernelIlSepKernel(ilSepKernel *obj, iflDataType type,
  53.                             void *xdata, int x, void *ydata,
  54.                             int y, void *zdata, int z)
  55.  
  56.  
  57.  
  58.      Construct a kernel by copying user data into the object.  If any of the
  59.      data pointers is NULL, data is still allocated for the indicated size,
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  71.  
  72.  
  73.  
  74.      and the values are initalized to 1. The kernel type is set to
  75.      _i_l_K_e_r_n_S_e_p_a_r_a_b_l_e.
  76.  
  77.      ggggeeeettttXXXXddddaaaattttaaaa(((())))
  78.  
  79.           void *ilSepKernelGetXdata(ilSepKernel *obj)
  80.  
  81.  
  82.           Returns a pointer to the X vector of the kernel.  Use the kernel
  83.           data type to cast the pointer to the correct type.
  84.  
  85.      ggggeeeettttXXXXeeeelllleeeemmmmeeeennnntttt(((())))
  86.  
  87.           double ilSepKernelGetXelement(ilSepKernel *obj, int n)
  88.  
  89.  
  90.           Returns the _nth element from the X vector of the kernel.
  91.  
  92.      ggggeeeettttYYYYddddaaaattttaaaa(((())))
  93.  
  94.           void *ilSepKernelGetYdata(ilSepKernel *obj)
  95.  
  96.  
  97.           Returns a pointer to the Y vector of the kernel.  Use the kernel
  98.           data type to cast the pointer to the correct type.
  99.  
  100.      ggggeeeettttYYYYeeeelllleeeemmmmeeeennnntttt(((())))
  101.  
  102.           double ilSepKernelGetYelement(ilSepKernel *obj, int n)
  103.  
  104.  
  105.           Returns the _nth element from the Y vector of the kernel.
  106.  
  107.      ggggeeeettttZZZZddddaaaattttaaaa(((())))
  108.  
  109.           void *ilSepKernelGetZdata(ilSepKernel *obj)
  110.  
  111.  
  112.           Returns a pointer to the Z vector of the kernel.  Use the kernel
  113.           data type to cast the pointer to the correct type.
  114.  
  115.      ggggeeeettttZZZZeeeelllleeeemmmmeeeennnntttt(((())))
  116.  
  117.           double ilSepKernelGetZelement(ilSepKernel *obj, int n)
  118.  
  119.  
  120.           Returns the _nth element from the Z vector of the kernel.
  121.  
  122.      sssseeeettttXXXXddddaaaattttaaaa(((())))
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  137.  
  138.  
  139.  
  140.           void ilSepKernelSetXdata(ilSepKernel *obj, void *xKernel)
  141.  
  142.  
  143.           Copies _d_a_t_a into the X vector of the kernel.  The data is assumed to
  144.           be of the type and dimensions corresponding to the size and type
  145.           used in the kernel construction.
  146.  
  147.      sssseeeettttXXXXeeeelllleeeemmmmeeeennnntttt(((())))
  148.  
  149.           void ilSepKernelSetXelement(ilSepKernel *obj, double val,
  150.                                       int n)
  151.  
  152.  
  153.           Sets the _nth element from the X vector of the kernel to _v_a_l.
  154.  
  155.      sssseeeettttYYYYddddaaaattttaaaa(((())))
  156.  
  157.           void ilSepKernelSetYdata(ilSepKernel *obj, void *yKernel)
  158.  
  159.  
  160.           Copies _d_a_t_a into the Y vector of the kernel.  The data is assumed to
  161.           be of the type and dimensions corresponding to the size and type
  162.           used in the kernel construction.
  163.  
  164.      sssseeeettttYYYYeeeelllleeeemmmmeeeennnntttt(((())))
  165.  
  166.           void ilSepKernelSetYelement(ilSepKernel *obj, double val,
  167.                                       int n)
  168.  
  169.  
  170.           Sets the _nth element from the Y vector of the kernel to _v_a_l.
  171.  
  172.      sssseeeettttZZZZddddaaaattttaaaa(((())))
  173.  
  174.           void ilSepKernelSetZdata(ilSepKernel *obj, void *zKernel)
  175.  
  176.  
  177.           Copies _d_a_t_a into the Z vector of the kernel.  The data is assumed to
  178.           be of the type and dimensions corresponding to the size and type
  179.           used in the kernel construction.
  180.  
  181.      sssseeeettttZZZZeeeelllleeeemmmmeeeennnntttt(((())))
  182.  
  183.           void ilSepKernelSetZelement(ilSepKernel *obj, double val,
  184.                                       int n)
  185.  
  186.  
  187.           Sets the _nth element from the Z vector of the kernel to _v_a_l.
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))     IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiillllSSSSeeeeppppKKKKeeeerrrrnnnneeeellll((((3333))))
  203.  
  204.  
  205.  
  206. INHERITED MEMBER FUNCTIONS
  207.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllKKKKeeeerrrrnnnneeeellll
  208.      ilKernelCalcGain(), ilKernelCopy(), ilKernelGetData(),
  209.      ilKernelGetDataType(), ilKernelGetElement(), ilKernelGetKernelType(),
  210.      ilKernelGetOrigin(), ilKernelGetSize(), ilKernelGetXsize(),
  211.      ilKernelGetYsize(), ilKernelGetZsize(), ilKernelIsClampSet(),
  212.      ilKernelIsEquivalent(), ilKernelScale(), ilKernelSetClamp(),
  213.      ilKernelSetData(), ilKernelSetElement(), ilKernelSetOrigin()
  214.  
  215.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllWWWWaaaattttcccchhhheeeeddddOOOObbbbjjjjeeeecccctttt
  216.      addWatchCallback(), doWatchCallbacks(), removeWatchCallback()
  217.  
  218. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  219.      ilKernel, ilSepSharpenKernel
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.